Enable ROR-Based Org Creation for Contributors by momo3404 · Pull Request #1243 · portagenetwork/roadmap

momo3404 · 2025-12-05T20:09:09Z

Fixes #926.

Changes proposed in this PR:

Edit contributor affiliation dropdown partial to allow for search for orgs external to DMP Assistant DB.
Edit contributions_controller to process orgs that are external to DMP Assistant DB by validating ROR.
The workflow is as follows after a user enters an affiliation for a contributor:
- If the affiliation already exists in the orgs table, the existing entry is used.
- If the affiliation does not exist in the orgs table, an external API request to ROR is made. If a matching result is found, the new organisation is added to the orgs table along with the ror and fundref identifiers.
- If the affiliation neither exists in the orgs table or on ROR, then there is no change made to the affiliation and an error message is displayed.

github-actions · 2025-12-05T20:09:31Z

	1 Error
🚫	Please include a CHANGELOG entry. You can find it at CHANGELOG.md.

Generated by 🚫 Danger

aaronskiba

This is a step forward, but I still can't help but wonder if moving the bulk of this logic inside of app/services/org_selection/hash_to_org_service.rb will simplify things even more.

You have 'shared/org_selectors/combined' in app/views/contributors/_form.html.erb, which is good; it should enable the ROR querying in the user search.

However, when I test it from integration it doesn't seem to work. It looks like the issue is the following:

      # app/services/external_apis/ror_service.rb
      def ping
        return true unless active? && heartbeat_path.present?

        resp = http_get(uri: "#{api_base_url}#{heartbeat_path}")
        byebug
        resp.present? && resp.code == 200
      end

(byebug) api_base_url
"https://api.ror.org/v1/"
(byebug) resp.present? && resp.code == 200
false
(byebug) resp
#<HTTParty::Response:0x10608 parsed_response={"errors"=>[{"status"=>"410", "title"=>"API Version Deprecated", "detail"=>"The v1 API has been deprecated. Please migrate to v2."}]}, @response=#<Net::HTTPGone 410 Gone readbody=true>, @headers={"date"=>["Tue, 09 Dec 2025 16:55:16 GMT"], "content-type"=>["application/json"], "content-length"=>["133"], "connection"=>["close"], "x-amzn-requestid"=>["23c106ef-fced-4488-a903-a468c6fd4d05"], "x-amzn-remapped-connection"=>["keep-alive"], "x-amz-apigw-id"=>["VVIiTH5ujoEEY0w="], "vary"=>["Origin"], "x-amzn-remapped-server"=>["nginx/1.18.0 + Phusion Passenger 6.0.7"], "status"=>["410 Gone"], "x-powered-by"=>["Phusion Passenger 6.0.7"], "x-amzn-remapped-date"=>["Tue, 09 Dec 2025 16:55:16 GMT"]}>
(byebug)

According to https://ror.readme.io/, as of today, api v1 is no longer available:

As of December 9, 2025, version 1 of the ROR schema and API has been sunset, meaning that ROR API requests with v1 in the path no longer return results, v1 files will no longer be included in the ROR data dump, and v1 documentation is no longer available. Read more in our changelog.

momo3404 · 2026-01-06T20:18:24Z

This is a step forward, but I still can't help but wonder if moving the bulk of this logic inside of app/services/org_selection/hash_to_org_service.rb will simplify things even more.

I think moving parse_org_json, validate_ror, and existing_org_from_hash to HashToOrgService could work, what do you think?

aaronskiba · 2026-01-06T20:51:49Z

This is a step forward, but I still can't help but wonder if moving the bulk of this logic inside of app/services/org_selection/hash_to_org_service.rb will simplify things even more.

I think moving parse_org_json, validate_ror, and existing_org_from_hash to HashToOrgService could work, what do you think?

app/services/org_selection/hash_to_org_service.rb has the

You have 'shared/org_selectors/combined' in app/views/contributors/_form.html.erb, which is good; it should enable the ROR querying in the user search.

I'm still wondering if You have 'shared/org_selectors/combined' in app/views/contributors/_form.html.erb, which is good; it should enable the ROR querying in the user search.

This is a step forward, but I still can't help but wonder if moving the bulk of this logic inside of app/services/org_selection/hash_to_org_service.rb will simplify things even more.

I think moving parse_org_json, validate_ror, and existing_org_from_hash to HashToOrgService could work, what do you think?

I could be wrong, but after the work we did in app/services/external_apis/ror_service.rb, I'm still leaning toward re-architecting this so that the work is done in app/services/org_selection/hash_to_org_service.rb.

I'd try setting allow_create: true) in ContributorsController#process_org and keep your 'shared/org_selectors/combined' change in app/views/contributors/_form.html.erb, but from there, I'd try doing this work in the HashToOrgService.

I'm looking at HashToOrgService#to_org. It looks like it might already be doing a lot of the work that you've implemented directly in this controller?

The combined org partial allows for a search for orgs outside of the local DB, and includes external orgs with valid RORs

Updated process_org to parse org_id input and check for an existing Org using the HashToOrgService before calling org_from_params. This avoids redundant calls to org_from_params and speeds up the process of adding a contributor if their org already exists in the DB. Also added finalize_org_hash helper method to avoid reuse of same code

- Add validate_ror helper function that makes an external API ROR request to ensure the external org picked from the dropdown has a valid ROR and that it is the correct one - This allows valid external orgs with RORs to be added to the DB - Also edit parse rescue result to nil since that is more readable

- The test stubs org_from_params to return new_org, but process_org may skip using new_org if it finds a different existing org based on org_name or parsed['id']. - The fix makes the test avoid real org lookup by clearing values that might cause that. This ensures existing_org_from_hash returns nil, allowing the stubbed org_from_params to be used.

- Use the debounce function to create debouncedToggleWarning. - Edit handleSelection to display the autocomplete warning only after 1 second of paused typing and hide it when user is typing

- Flash message displays when an org is not present in orgs table AND does not pass ROR validation - Add request.present? to message condition in order for controller tests to work properly

app/controllers/contributors_controller.rb

…roller

- Stub ror hash to allow for new org creation

app/controllers/contributors_controller.rb

aaronskiba · 2026-01-16T22:23:27Z

Maybe something like Enable ROR-Based Org Creation for Contributors would be a better PR title if we ever have to lookup these changes in the future.

momo3404 · 2026-01-16T22:24:53Z

Maybe something like Enable ROR-Based Org Creation for Contributors would be a better PR title if we ever have to lookup these changes in the future.

Sounds good, I can change it for the official PR once we're done with the draft one.

aaronskiba · 2026-01-19T17:33:49Z

I like the delay on the error message. But maybe it shouldn't pop up after only entering one or two characters?

EDIT: Maybe this behaviour existed prior to these changes?

aaronskiba · 2026-01-19T17:37:10Z

This PR will prevent users from adding "junk orgs" to the db. At the same time, we should try to not render those junk orgs in the dropdown list. For example, we probably don't want users to see all of these "test" options. We should try to figure out a way to filter out these unwanted orgs.

Edit: I might try to expand upon #1250. Maybe some more "junk orgs" could be removed via this rake task.

aaronskiba · 2026-01-19T18:27:51Z

When I add a non-db / non-ROR org, the contributor still gets saved to the db with org.id == nil. I also get Error: Invalid contributor affiliation. Please double check that your organisation does not appear in the list in a slightly different form.

The prior behaviour would also create the contributor with org.id == nil; maybe we want to preserve that behaviour like we are here. But if so, this feels confusing because the contributor creation succeeded, but the error message suggests something went wrong.

If we are maintaining the behaviour, maybe the flash message should be changed to something like the following:

flash[:notice] = _('Contributor saved without affiliation. If you intended to add an affiliation, please check if the organisation appears in the list in a different form.')

momo3404 · 2026-01-19T20:29:16Z

I like the delay on the error message. But maybe it shouldn't pop up after only entering one or two characters?
EDIT: Maybe this behaviour existed prior to these changes?

Should I add a limit then? Or what should be the behaviour be? The previous behavior had the error message showing up immediately after the first letter was typed.

momo3404 · 2026-01-19T20:31:21Z

When I add a non-db / non-ROR org, the contributor still gets saved to the db with org.id == nil. I also get Error: Invalid contributor affiliation. Please double check that your organisation does not appear in the list in a slightly different form.

The prior behaviour would also create the contributor with org.id == nil; maybe we want to preserve that behaviour like we are here. But if so, this feels confusing because the contributor creation succeeded, but the error message suggests something went wrong.

If we are maintaining the behaviour, maybe the flash message should be changed to something like the following:

flash[:notice] = _('Contributor saved without affiliation. If you intended to add an affiliation, please check if the organisation appears in the list in a different form.')

I agree that the prior behaviour of saving the contributor should remain as is, I'll change the flash message.

momo3404 · 2026-01-19T21:02:54Z

This PR will prevent users from adding "junk orgs" to the db. At the same time, we should try to not render those junk orgs in the dropdown list. For example, we probably don't want users to see all of these "test" options. We should try to figure out a way to filter out these unwanted orgs.

Edit: I might try to expand upon #1250. Maybe some more "junk orgs" could be removed via this rake task.

I think a separate rake task to address this would be the best solution. Could be part of the next release with this and the funders PR.

spec/services/org_selection/hash_to_org_service_spec.rb

app/services/org_selection/hash_to_org_service.rb

momo3404 self-assigned this Dec 5, 2025

aaronskiba reviewed Dec 9, 2025

View reviewed changes

momo3404 added 8 commits January 12, 2026 10:37

Update contributors form to use different org partial

39cf09d

The combined org partial allows for a search for orgs outside of the local DB, and includes external orgs with valid RORs

Add parse_org_json helper function

c3e748a

Update autocomplete warning in combined org partial

291a36c

Update autoComplete.js to delay showing autocomplete warning

c4f9a21

- Use the debounce function to create debouncedToggleWarning. - Edit handleSelection to display the autocomplete warning only after 1 second of paused typing and hide it when user is typing

Add flash error message for invalid orgs

7ca17b2

- Flash message displays when an org is not present in orgs table AND does not pass ROR validation - Add request.present? to message condition in order for controller tests to work properly

momo3404 force-pushed the momo/issues/926-edit branch from 868ecf3 to 7ca17b2 Compare January 12, 2026 17:37

momo3404 marked this pull request as draft January 12, 2026 18:22

aaronskiba reviewed Jan 13, 2026

View reviewed changes

app/controllers/contributors_controller.rb Outdated Show resolved Hide resolved

Move org processing code to HashToOrgService

31fb8d9

momo3404 force-pushed the momo/issues/926-edit branch from d5217a2 to 31fb8d9 Compare January 15, 2026 17:10

momo3404 added 2 commits January 15, 2026 13:10

Remove validate_ror and return existing org boolean

68cf1ae

Work with initialize_org

c822915

aaronskiba reviewed Jan 16, 2026

View reviewed changes

app/controllers/contributors_controller.rb Outdated Show resolved Hide resolved

aaronskiba reviewed Jan 16, 2026

View reviewed changes

app/controllers/contributors_controller.rb Outdated Show resolved Hide resolved

momo3404 added 2 commits January 16, 2026 14:07

fix tests in contributions_controller_spec to not use request in cont…

8fe8fdd

…roller

Fix breaking hash_to_org_service_spec tests

a2c67da

- Stub ror hash to allow for new org creation

aaronskiba reviewed Jan 16, 2026

View reviewed changes

app/controllers/contributors_controller.rb Show resolved Hide resolved

Remove redundant org check

b24a2f0

momo3404 changed the title ~~Allow contributor affiliation to belong to external organisations~~ Enable ROR-Based Org Creation for Contributors Jan 16, 2026

Edit flash error message

4539a00

aaronskiba reviewed Jan 20, 2026

View reviewed changes

spec/services/org_selection/hash_to_org_service_spec.rb Outdated Show resolved Hide resolved

Add tests to hash_to_org_service_spec

1a4cf75

aaronskiba reviewed Jan 21, 2026

View reviewed changes

spec/services/org_selection/hash_to_org_service_spec.rb Outdated Show resolved Hide resolved

update hash_to_org_service_spec

c0678e2

aaronskiba reviewed Jan 23, 2026

View reviewed changes

app/services/org_selection/hash_to_org_service.rb Show resolved Hide resolved

Refactor match_hash_to_ror_org function

114806a

Conversation

momo3404 commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

aaronskiba left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

momo3404 commented Jan 6, 2026

Uh oh!

aaronskiba commented Jan 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aaronskiba commented Jan 16, 2026

Uh oh!

momo3404 commented Jan 16, 2026

Uh oh!

aaronskiba commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaronskiba commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaronskiba commented Jan 19, 2026

Uh oh!

momo3404 commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

momo3404 commented Jan 19, 2026

Uh oh!

momo3404 commented Jan 19, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

momo3404 commented Dec 5, 2025 •

edited

Loading

aaronskiba left a comment •

edited

Loading

aaronskiba commented Jan 19, 2026 •

edited

Loading

aaronskiba commented Jan 19, 2026 •

edited

Loading

momo3404 commented Jan 19, 2026 •

edited

Loading